GET StatusTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves status types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of status types to retrieve. Default is all status types |
integer |
None. |
skip |
Number of status types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the status types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of status types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of StatusType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "StatusTypeId": "85baf6d2-67bb-4c39-aa27-67da09af3fd1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d20bd2b4-4ef9-46ae-a784-4fc58422a97d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "acdeab0e-984d-4d60-bb84-6b08d33b8ed7", "CreateDate": "2024-05-06T12:09:48.3334072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:09:48.3334072-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "916d23eb-2cda-462a-8cda-5f716a894436", "CreateDate": "2024-05-06T12:09:48.3334072-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T12:09:48.3334072-07:00", "LastModifiedUser": "sample string 7" }, { "StatusTypeId": "85baf6d2-67bb-4c39-aa27-67da09af3fd1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d20bd2b4-4ef9-46ae-a784-4fc58422a97d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "acdeab0e-984d-4d60-bb84-6b08d33b8ed7", "CreateDate": "2024-05-06T12:09:48.3334072-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:09:48.3334072-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "916d23eb-2cda-462a-8cda-5f716a894436", "CreateDate": "2024-05-06T12:09:48.3334072-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T12:09:48.3334072-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }